<?php

/**
 * Maikuro Framework
 *
 * LICENSE:
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * The license is bundled with this package in the file LICENSE.txt.
 * You may also obtain a copy of the License at this URL:
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * @copyright  Copyright (c) 2010, Jonathan Hedrén
 * @author     Jonathan Hedrén <jonathan.hedren@gmail.com>
 * @license    http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

require_once 'AbstractFormElement.php';

class CheckboxFormElement extends AbstractFormElement
{
    /**
     * As non-checked checkboxes not are posted this form element has a default
     * value set to 'false'.
     *
     * @var boolean
     */
    protected $value = false;

    /**
     *
     * @return boolean
     */
    public function isChecked()
    {
        return $this->value;
    }

    /**
     *
     * @param mixed $value
     * @return CheckboxFormElement
     */
    public function setValue($value)
    {
        $this->value = (boolean) $value;
        return $this;
    }

}